Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add plugins for TagBot and CompatHelper #107

Merged
merged 9 commits into from
Dec 18, 2019
Merged

Add plugins for TagBot and CompatHelper #107

merged 9 commits into from
Dec 18, 2019

Conversation

christopher-dG
Copy link
Member

Closes #105

TagBot is a default plugin due to its wide adoption, but I think I will wait until CompatHelper hits 1.0 before making it default.

@carstenbauer
Copy link

carstenbauer commented Nov 12, 2019

May I add that it would be great if these plugins were to support custom registries right from the start.

For example, they could take a custom_registry keyword that would trigger the supplementation of the workflows:

  • Add registry: user/CustomRegistry entry to TagBot.yml.
  • Use CompatHelper.main(; registries=...) (see here for an example)

Assuming that custom_registry would take a URL to the registry the only not super straightforward part is that to do the latter we need the UUID information of the custom registry. But I guess we can just look it up in the Registry.toml file in the root of the registry repo.

@codecov
Copy link

codecov bot commented Nov 12, 2019

Codecov Report

Merging #107 into master will increase coverage by 0.19%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #107      +/-   ##
==========================================
+ Coverage   91.84%   92.04%   +0.19%     
==========================================
  Files          15       17       +2     
  Lines         319      327       +8     
==========================================
+ Hits          293      301       +8     
  Misses         26       26
Impacted Files Coverage Δ
src/PkgTemplates.jl 100% <ø> (ø) ⬆️
src/plugin.jl 87.87% <ø> (ø) ⬆️
src/plugins/ci.jl 91.66% <ø> (ø) ⬆️
src/plugins/tagbot.jl 100% <100%> (ø)
src/plugins/compat_helper.jl 100% <100%> (ø)
src/template.jl 100% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a41187b...8389127. Read the comment docs.

@christopher-dG
Copy link
Member Author

I'm not going to do the CompatHelper one for now because it wouldn't have a very nice API (registries=[(name=..., uuid=..., url=...)] I guess), but I just pushed the TagBot changes I was sitting on.
The CompatHelper plugin does have a file option though, so you can just supply your own workflow file with any registries you need.

@carstenbauer
Copy link

I'm not going to do the CompatHelper one for now because it wouldn't have a very nice API (registries=[(name=..., uuid=..., url=...)] I guess)

If we were to restrict ourselves to just a single custom repository I don't think the API would have to be like this. As I said above, we could use the same API as for TagBot: from "owner/registryrepo" we can generate the URL "http://github.com/owner/registryrepo/Registry.toml", where we find the name and uuid information of the custom registry.

@christopher-dG
Copy link
Member Author

Yeah I'm cool with that API. But since that requires HTTP, I'm going to wait on implementing it until we do more HTTP-related things (#79).

@christopher-dG
Copy link
Member Author

This is good to go, I'm just thinking about how I want to deal with JuliaRegistries/TagBot#36 (the TagBot template will change if I do the underscored inputs).

@DilumAluthge
Copy link
Member

@christopher-dG Just FYI- I just registered CompatHelper version 1.0.0. It will be automerged within an hour.

Since the CompatHelper API is stable, how do you feel about it making it a default?

@christopher-dG
Copy link
Member Author

Yeah I'm cool with defaulting it, seems like it's been very well-received by the community.
Would love to see JuliaRegistries/CompatHelper.jl#123 released first though, since that makes the templating much easier and prettier 🙂

@christopher-dG
Copy link
Member Author

I'm gonna go ahead and merge this tonight (after I merge some stuff in TagBot). Custom registries are not supported in the default CompatHelper template, but you can bring your own if you need for now. Default support will come when CompatHelper has a nice config option for it.

@christopher-dG christopher-dG merged commit ab9949a into master Dec 18, 2019
@christopher-dG christopher-dG deleted the cdg/actions branch December 18, 2019 04:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature request: Auto-generate the GitHub Actions workflow file for CompatHelper.jl
3 participants